Saltar al contenido principal
GET
/
channels
/
{id}
Obtener canal
curl --request GET \
  --url https://api.example.com/channels/{id}
{
  "data": {
    "id": "app",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "App móvil",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Landing de la app",
      "entity": "CHANNELS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "hero_title",
          "type": "TEXT",
          "label": { "en_us": "Título principal" },
          "required": true,
          "value": "Pide desde nuestra app"
        }
      ]
    }
  }
}
Devuelve un canal por su id externo. Usa este endpoint después de que el cliente seleccione un canal para cargar su nombre, estado y contenido CMS en el storefront.
Requiere un access token de Fire spark obtenido mediante intercambio de token.

​
Parámetros de ruta

ParámetroRequeridoDescripción
idSíIdentificador externo del canal. Solo alfanuméricos, _ y -. 1–64 caracteres.

​
Solicitud

curl "https://firespark.vercel.app/api/storefront/v1/channels/app" \
  -H "Authorization: Bearer ACCESS_TOKEN"

​
Respuesta

La respuesta envuelve un objeto channel en data. La forma coincide con listar canales. 
{
  "data": {
    "id": "app",
    "uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "name": "App móvil",
    "status": "ACTIVE",
    "cms_template_id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
    "cms": {
      "id": "d4e5f6a7-b8c9-0123-def4-567890abcdef",
      "name": "Landing de la app",
      "entity": "CHANNELS",
      "status": "ACTIVE",
      "fields": [
        {
          "name": "hero_title",
          "type": "TEXT",
          "label": { "en_us": "Título principal" },
          "required": true,
          "value": "Pide desde nuestra app"
        }
      ]
    }
  }
}

​
Campos del canal

Consulta listar canales para el esquema completo, incluyendo cms_template_id y cms.
Usa el id del canal al cargar menús y tiendas acotados a una superficie de pedido específica.

​
Respuestas de error

EstadoDescripción
401Access token ausente o inválido.
403El token no tiene acceso a este canal.
404No se encontró un canal con el id indicado.